// 《围棋》作者版权所有。版权所有。
// 此源代码的使用受BSD样式
// 许可证的约束，该许可证可以在许可证文件中找到。

package runtime

import (
	"runtime/internal/atomic"
	"runtime/internal/sys"
	"unsafe"
)

const itabInitSize = 512

var (
	itabLock      mutex                               // 访问itab表的锁
	itabTable     = &itabTableInit                    // 指向当前表的指针
	itabTableInit = itabTableType{size: itabInitSize} // 起始表
)

// 注意：如果更改这些字段，请更改itabAdd中mallocgc调用中的公式。
type itabTableType struct {
	size    uintptr             // 条目长度数组。总是2的幂。
	count   uintptr             // 当前填写的条目数。
	entries [itabInitSize]*itab // 确实[size]大型
}

func itabHashFunc(inter *interfacetype, typ *_type) uintptr {
	// 编译器为我们提供了一些很好的哈希代码。
	return uintptr(inter.typ.hash ^ typ.hash)
}

func getitab(inter *interfacetype, typ *_type, canfail bool) *itab {
	if len(inter.mhdr) == 0 {
		throw("internal error - misuse of itab")
	}

	// 简单案例
	if typ.tflag&tflagUncommon == 0 {
		if canfail {
			return nil
		}
		name := inter.typ.nameOff(inter.mhdr[0].name)
		panic(&TypeAssertionError{nil, typ, &inter.typ, name.name()})
	}

	var m *itab

	// 首先，查看现有表格，看看是否可以找到我们需要的itab。
	// 这是目前为止最常见的情况，所以不要使用锁。
	// 使用atomic确保我们看到线程
	// 更新itabTable字段（在itabAdd中使用atomic.Storep）之前所做的任何写入操作。
	t := (*itabTableType)(atomic.Loadp(unsafe.Pointer(&itabTable)))
	if m = t.find(inter, typ); m != nil {
		goto finish
	}

	// 未找到。抓住锁，再试一次。
	lock(&itabLock)
	if m = itabTable.find(inter, typ); m != nil {
		unlock(&itabLock)
		goto finish
	}

	// 条目尚不存在。创建一个新条目并添加它。
	m = (*itab)(persistentalloc(unsafe.Sizeof(itab{})+uintptr(len(inter.mhdr)-1)*sys.PtrSize, 0, &memstats.other_sys))
	m.inter = inter
	m._type = typ
	// 散列用于类型开关。但是，编译器静态地为交换机中使用的所有接口/类型对生成itab的
	// （在itabsinit中添加到itabTable 
	// ）。动态生成的itab从不参与类型切换，
	// 因此哈希是不相关的。
	// 注意：m.hash不是用于运行时itabTable哈希表的哈希。
	m.hash = 0
	m.init()
	itabAdd(m)
	unlock(&itabLock)
finish:
	if m.fun[0] != 0 {
		return m
	}
	if canfail {
		return nil
	}
	// 只有在转换
	// 已经使用ok表单
	// 完成一次，并且缓存了一个否定结果时，才会发生这种情况。
	// 缓存的结果没有记录缺少哪个
	// 接口函数，因此再次初始化
	// itab以获取缺少的函数名。
	panic(&TypeAssertionError{concrete: typ, asserted: &inter.typ, missingMethod: m.init()})
}

// find在t中查找给定的接口/类型对。
// 如果给定的接口/类型对不存在，则返回nil。
func (t *itabTableType) find(inter *interfacetype, typ *_type) *itab {
	// 使用二次探测实现。
	// 探针序列为h（i）=h0+i*（i+1）/2模2^k。
	// 我们保证使用此探测序列命中所有表项。
	mask := t.size - 1
	h := itabHashFunc(inter, typ) & mask
	for i := uintptr(1); ; i++ {
		p := (**itab)(add(unsafe.Pointer(&t.entries), h*sys.PtrSize))
		// 在这里使用原子读取，因此如果我们看到m！=nil，我们还可以看到
		// m的字段的初始化。
		// m:=*p 
		m := (*itab)(atomic.Loadp(unsafe.Pointer(p)))
		if m == nil {
			return nil
		}
		if m.inter == inter && m._type == typ {
			return m
		}
		h += i
		h &= mask
	}
}

// itabAdd将给定的itab添加到itab哈希表中。
// ITABBLOCK必须保持。
func itabAdd(m *itab) {
	// 错误可能导致在设置mallocing时调用此函数，
	// 通常是因为在恐慌时调用此函数。
	// 可靠崩溃，而不仅仅是当我们需要增加哈希表时。
	if getg().m.mallocing != 0 {
		throw("malloc deadlock")
	}

	t := itabTable
	if t.count >= 3*(t.size/4) { // 75%加载因子
		// /增长哈希表。
		// t2=new（itabTableType）+一些附加条目
		// 我们撒谎并告诉malloc我们需要无指针内存，因为
		// 所有指向的值都不在堆中。
		t2 := (*itabTableType)(mallocgc((2+2*t.size)*sys.PtrSize, nil, true))
		t2.size = t.size * 2

		// 复制条目。
		// 注意：复制时，其他线程可能会查找itab，而
		// 找不到它。没关系，然后他们会尝试获取itab锁
		// 并因此等待复制完成。
		iterate_itabs(t2.add)
		if t2.count != t.count {
			throw("mismatched count during itab table copy")
		}
		// 发布新哈希表。使用原子写入：请参阅getitab中的注释。
		atomicstorep(unsafe.Pointer(&itabTable), unsafe.Pointer(t2))
		// 采用新表格作为我们自己的表格。
		t = itabTable
		// 注意：旧表可以在这里使用。
	}
	t.add(m)
}

// add将给定的itab添加到itab表t中。
// ITABBLOCK必须保持。
func (t *itabTableType) add(m *itab) {
	// 请参阅查找中有关探测序列的注释。
	// 在探测序列的第一个空白点插入新的itab。
	mask := t.size - 1
	h := itabHashFunc(m.inter, m._type) & mask
	for i := uintptr(1); ; i++ {
		p := (**itab)(add(unsafe.Pointer(&t.entries), h*sys.PtrSize))
		m2 := *p
		if m2 == m {
			// 一个给定的itab可以用于多个模块
			// 由于全局符号解析的工作方式，指向itab的
			// 可能已经插入到
			// 全局“哈希”中。
			return
		}
		if m2 == nil {
			// 在此处使用原子写入，因此如果读取器看到m，它也会看到m的正确初始化字段。
			// NoWB正常，因为m不在堆内存中。
			// *p=m 
			atomic.StorepNoWB(unsafe.Pointer(p), unsafe.Pointer(m))
			t.count++
			return
		}
		h += i
		h &= mask
	}
}

// /init使用
// /m.inter/m.\u类型对的所有代码指针填充m.fun数组。如果类型未实现接口，则
// 它将m.fun[0]设置为0，并返回缺少的接口函数的名称。
// 可以在同一个m上多次调用它，即使是同时调用。
func (m *itab) init() string {
	inter := m.inter
	typ := m._type
	x := typ.uncommon()

	// inter和typ都有按名称排序的方法，
	// 并且接口名称是唯一的，
	// 因此可以在锁步中迭代这两个方法；
	// 循环是O（ni+nt）而不是O（ni*nt）。
	ni := len(inter.mhdr)
	nt := int(x.mcount)
	xmhdr := (*[1 << 16]method)(add(unsafe.Pointer(x), uintptr(x.moff)))[:nt:nt]
	j := 0
	methods := (*[1 << 16]unsafe.Pointer)(unsafe.Pointer(&m.fun[0]))[:ni:ni]
	var fun0 unsafe.Pointer
imethods:
	for k := 0; k < ni; k++ {
		i := &inter.mhdr[k]
		itype := inter.typ.typeOff(i.ityp)
		name := inter.typ.nameOff(i.name)
		iname := name.name()
		ipkg := name.pkgPath()
		if ipkg == "" {
			ipkg = inter.pkgpath.name()
		}
		for ; j < nt; j++ {
			t := &xmhdr[j]
			tname := typ.nameOff(t.name)
			if typ.typeOff(t.mtyp) == itype && tname.name() == iname {
				pkgPath := tname.pkgPath()
				if pkgPath == "" {
					pkgPath = typ.nameOff(x.pkgpath).name()
				}
				if tname.isExported() || pkgPath == ipkg {
					if m != nil {
						ifn := typ.textOff(t.ifn)
						if k == 0 {
							fun0 = ifn // 我们将在末尾设置m.fun[0]
						} else {
							methods[k] = ifn
						}
					}
					continue imethods
				}
			}
		}
		// 未找到方法
		m.fun[0] = 0
		return iname
	}
	m.fun[0] = uintptr(fun0)
	return ""
}

func itabsinit() {
	lockInit(&itabLock, lockRankItab)
	lock(&itabLock)
	for _, md := range activeModules() {
		for _, i := range md.itablinks {
			itabAdd(i)
		}
	}
	unlock(&itabLock)
}

// 在执行e.（t）转换时调用了PanidDotTypee，转换失败。
// have=我们拥有的动态类型。
// want=我们试图转换为的静态类型。
// iface=我们正在转换的静态类型。
func panicdottypeE(have, want, iface *_type) {
	panic(&TypeAssertionError{iface, have, want, ""})
}

// i（T）转换时调用panicdottypeI，转换失败。
// 参数与panicdottype相同，但“have”是我们拥有的动态itab。
func panicdottypeI(have *itab, want, iface *_type) {
	var t *_type
	if have != nil {
		t = have._type
	}
	panicdottypeE(t, want, iface)
}

// i（T）转换时调用panicnildottype，接口i为nil。
// want=我们试图转换为的静态类型。
func panicnildottype(want *_type) {
	panic(&TypeAssertionError{nil, nil, want, ""})
	// TODO:添加我们转换的静态类型。
	// 它可能会生成更好的错误消息。
	// 为了匹配其他零转换错误，我们暂时不需要。
}

// 专用的convTx例程在调用mallocgc时需要使用类型描述符。
// 我们不需要精确的类型，只需要有正确的大小、对齐方式和指针大小。
// 然而，在调试时，最好在mallocgc中有一些类型来源的指示，
// 所以我们在这里使用命名类型。
// 然后构造这些类型的接口值，
// 然后根据需要提取要使用的类型字。
type (
	uint16InterfacePtr uint16
	uint32InterfacePtr uint32
	uint64InterfacePtr uint64
	stringInterfacePtr string
	sliceInterfacePtr  []byte
)

var (
	uint16Eface interface{} = uint16InterfacePtr(0)
	uint32Eface interface{} = uint32InterfacePtr(0)
	uint64Eface interface{} = uint64InterfacePtr(0)
	stringEface interface{} = stringInterfacePtr("")
	sliceEface  interface{} = sliceInterfacePtr(nil)

	uint16Type *_type = efaceOf(&uint16Eface)._type
	uint32Type *_type = efaceOf(&uint32Eface)._type
	uint64Type *_type = efaceOf(&uint64Eface)._type
	stringType *_type = efaceOf(&stringEface)._type
	sliceType  *_type = efaceOf(&sliceEface)._type
)

// 下面的conv和assert函数做的事情非常相似。
// 编译器保证convXXX函数成功。
// assertXXX函数可能会失败（要么惊慌失措，要么返回false，
// 这取决于它们是1-result还是2-result）。
// convXXX函数在nil输入时成功，而assertXXX 
// 函数在nil输入时失败。

func convT2E(t *_type, elem unsafe.Pointer) (e eface) {
	if raceenabled {
		raceReadObjectPC(t, elem, getcallerpc(), funcPC(convT2E))
	}
	if msanenabled {
		msanread(elem, t.size)
	}
	x := mallocgc(t.size, t, true)
	// TODO:我们分配一个归零的对象只是为了用实际数据覆盖它。
	// 找出如何避免归零。下面还有convT2Eslice、convT2I、convT2Islice。
	typedmemmove(t, x, elem)
	e._type = t
	e.data = x
	return
}

func convT16(val uint16) (x unsafe.Pointer) {
	if val < uint16(len(staticuint64s)) {
		x = unsafe.Pointer(&staticuint64s[val])
		if sys.BigEndian {
			x = add(x, 6)
		}
	} else {
		x = mallocgc(2, uint16Type, false)
		*(*uint16)(x) = val
	}
	return
}

func convT32(val uint32) (x unsafe.Pointer) {
	if val < uint32(len(staticuint64s)) {
		x = unsafe.Pointer(&staticuint64s[val])
		if sys.BigEndian {
			x = add(x, 4)
		}
	} else {
		x = mallocgc(4, uint32Type, false)
		*(*uint32)(x) = val
	}
	return
}

func convT64(val uint64) (x unsafe.Pointer) {
	if val < uint64(len(staticuint64s)) {
		x = unsafe.Pointer(&staticuint64s[val])
	} else {
		x = mallocgc(8, uint64Type, false)
		*(*uint64)(x) = val
	}
	return
}

func convTstring(val string) (x unsafe.Pointer) {
	if val == "" {
		x = unsafe.Pointer(&zeroVal[0])
	} else {
		x = mallocgc(unsafe.Sizeof(val), stringType, true)
		*(*string)(x) = val
	}
	return
}

func convTslice(val []byte) (x unsafe.Pointer) {
	// 注意：这必须适用于任何元素类型，而不仅仅是字节。
	if (*slice)(unsafe.Pointer(&val)).array == nil {
		x = unsafe.Pointer(&zeroVal[0])
	} else {
		x = mallocgc(unsafe.Sizeof(val), sliceType, true)
		*(*[]byte)(x) = val
	}
	return
}

func convT2Enoptr(t *_type, elem unsafe.Pointer) (e eface) {
	if raceenabled {
		raceReadObjectPC(t, elem, getcallerpc(), funcPC(convT2Enoptr))
	}
	if msanenabled {
		msanread(elem, t.size)
	}
	x := mallocgc(t.size, t, false)
	memmove(x, elem, t.size)
	e._type = t
	e.data = x
	return
}

func convT2I(tab *itab, elem unsafe.Pointer) (i iface) {
	t := tab._type
	if raceenabled {
		raceReadObjectPC(t, elem, getcallerpc(), funcPC(convT2I))
	}
	if msanenabled {
		msanread(elem, t.size)
	}
	x := mallocgc(t.size, t, true)
	typedmemmove(t, x, elem)
	i.tab = tab
	i.data = x
	return
}

func convT2Inoptr(tab *itab, elem unsafe.Pointer) (i iface) {
	t := tab._type
	if raceenabled {
		raceReadObjectPC(t, elem, getcallerpc(), funcPC(convT2Inoptr))
	}
	if msanenabled {
		msanread(elem, t.size)
	}
	x := mallocgc(t.size, t, false)
	memmove(x, elem, t.size)
	i.tab = tab
	i.data = x
	return
}

func convI2I(inter *interfacetype, i iface) (r iface) {
	tab := i.tab
	if tab == nil {
		return
	}
	if tab.inter == inter {
		r.tab = tab
		r.data = i.data
		return
	}
	r.tab = getitab(inter, tab._type, false)
	r.data = i.data
	return
}

func assertI2I(inter *interfacetype, tab *itab) *itab {
	if tab == nil {
		// 显式转换需要非nil接口值。
		panic(&TypeAssertionError{nil, nil, &inter.typ, ""})
	}
	if tab.inter == inter {
		return tab
	}
	return getitab(inter, tab._type, false)
}

func assertI2I2(inter *interfacetype, i iface) (r iface) {
	tab := i.tab
	if tab == nil {
		return
	}
	if tab.inter != inter {
		tab = getitab(inter, tab._type, true)
		if tab == nil {
			return
		}
	}
	r.tab = tab
	r.data = i.data
	return
}

func assertE2I(inter *interfacetype, t *_type) *itab {
	if t == nil {
		// 显式转换需要非nil接口值。
		panic(&TypeAssertionError{nil, nil, &inter.typ, ""})
	}
	return getitab(inter, t, false)
}

func assertE2I2(inter *interfacetype, e eface) (r iface) {
	t := e._type
	if t == nil {
		return
	}
	tab := getitab(inter, t, true)
	if tab == nil {
		return
	}
	r.tab = tab
	r.data = e.data
	return
}

// go:linkname reflect_-ifaceE2I reflect.ifaceE2I 
func reflect_ifaceE2I(inter *interfacetype, e eface, dst *iface) {
	*dst = iface{assertE2I(inter, e._type), e.data}
}

// go:linkname reflectlite_-ifaceE2I internal/reflectlite.ifaceE2I 
func reflectlite_ifaceE2I(inter *interfacetype, e eface, dst *iface) {
	*dst = iface{assertE2I(inter, e._type), e.data}
}

func iterate_itabs(fn func(*itab)) {
	// 注意：仅在stop the world期间运行或在保持IT
	// 因此不需要其他锁/原子。
	t := itabTable
	for i := uintptr(0); i < t.size; i++ {
		m := *(**itab)(add(unsafe.Pointer(&t.entries), i*sys.PtrSize))
		if m != nil {
			fn(m)
		}
	}
}

// staticuint64s用于避免在convTx中为小整数值分配。
var staticuint64s = [...]uint64{
	0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07,
	0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f,
	0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17,
	0x18, 0x19, 0x1a, 0x1b, 0x1c, 0x1d, 0x1e, 0x1f,
	0x20, 0x21, 0x22, 0x23, 0x24, 0x25, 0x26, 0x27,
	0x28, 0x29, 0x2a, 0x2b, 0x2c, 0x2d, 0x2e, 0x2f,
	0x30, 0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37,
	0x38, 0x39, 0x3a, 0x3b, 0x3c, 0x3d, 0x3e, 0x3f,
	0x40, 0x41, 0x42, 0x43, 0x44, 0x45, 0x46, 0x47,
	0x48, 0x49, 0x4a, 0x4b, 0x4c, 0x4d, 0x4e, 0x4f,
	0x50, 0x51, 0x52, 0x53, 0x54, 0x55, 0x56, 0x57,
	0x58, 0x59, 0x5a, 0x5b, 0x5c, 0x5d, 0x5e, 0x5f,
	0x60, 0x61, 0x62, 0x63, 0x64, 0x65, 0x66, 0x67,
	0x68, 0x69, 0x6a, 0x6b, 0x6c, 0x6d, 0x6e, 0x6f,
	0x70, 0x71, 0x72, 0x73, 0x74, 0x75, 0x76, 0x77,
	0x78, 0x79, 0x7a, 0x7b, 0x7c, 0x7d, 0x7e, 0x7f,
	0x80, 0x81, 0x82, 0x83, 0x84, 0x85, 0x86, 0x87,
	0x88, 0x89, 0x8a, 0x8b, 0x8c, 0x8d, 0x8e, 0x8f,
	0x90, 0x91, 0x92, 0x93, 0x94, 0x95, 0x96, 0x97,
	0x98, 0x99, 0x9a, 0x9b, 0x9c, 0x9d, 0x9e, 0x9f,
	0xa0, 0xa1, 0xa2, 0xa3, 0xa4, 0xa5, 0xa6, 0xa7,
	0xa8, 0xa9, 0xaa, 0xab, 0xac, 0xad, 0xae, 0xaf,
	0xb0, 0xb1, 0xb2, 0xb3, 0xb4, 0xb5, 0xb6, 0xb7,
	0xb8, 0xb9, 0xba, 0xbb, 0xbc, 0xbd, 0xbe, 0xbf,
	0xc0, 0xc1, 0xc2, 0xc3, 0xc4, 0xc5, 0xc6, 0xc7,
	0xc8, 0xc9, 0xca, 0xcb, 0xcc, 0xcd, 0xce, 0xcf,
	0xd0, 0xd1, 0xd2, 0xd3, 0xd4, 0xd5, 0xd6, 0xd7,
	0xd8, 0xd9, 0xda, 0xdb, 0xdc, 0xdd, 0xde, 0xdf,
	0xe0, 0xe1, 0xe2, 0xe3, 0xe4, 0xe5, 0xe6, 0xe7,
	0xe8, 0xe9, 0xea, 0xeb, 0xec, 0xed, 0xee, 0xef,
	0xf0, 0xf1, 0xf2, 0xf3, 0xf4, 0xf5, 0xf6, 0xf7,
	0xf8, 0xf9, 0xfa, 0xfb, 0xfc, 0xfd, 0xfe, 0xff,
}

// 链接器将其确定的方法的引用重定向到无法访问此函数的引用，因此如果调用过
// 它将抛出。
func unreachableMethod() {
	throw("unreachable method called. linker bug?")
}
